home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Gold Collection / Software Vault - The Gold Collection (American Databankers) (1993).ISO / cdr15 / vivtools.zip / VTOOLS.DOC < prev   
Text File  |  1993-06-01  |  9KB  |  213 lines
  1.                     Object Tools For Vivid Raytracers 
  2.                       By N. Martina - October 1992.     
  3.    
  4.    
  5. HISTORY --------------------------------------------------------------------
  6.  
  7.        This project started out one night while I was busy planning an
  8.     image which would contain many different primitives floating in the 
  9.     air. The cube, sphere, disk, triangle, parabola, torus and ellipsoid.
  10.     A pyramid was on the list but also came some other primitives related
  11.     to the pyramid. Aha! Those "3-D polygons". Since I like to have my 
  12.     computer do "most everything" for me, and I happen to know some 
  13.     programming, I thought it would be nice to have a few utilities 
  14.     generate some of the objects that are not provided by the raytracer.
  15.     So here they are, 
  16.                          
  17.                          ARCTORUS.EXE   
  18.                           PYRAMID.EXE
  19.                           POLYGON.EXE
  20.                              QUAD.EXE
  21.                           SPHERES.EXE
  22.  
  23.     My tool box is now empty. I'm giving away those tools to the public.
  24.                           
  25.                                FREE!
  26.  
  27.  
  28. PROG. INFO.-----------------------------------------------------------------
  29.  
  30.     To all those traceaholics like me, who spend most of their leisure 
  31.     hours raytracing. I hope you can find some use out of them. I like
  32.     them, of course, but I know their limitations. I did not plan to
  33.     distribute them in their command-line versions since I'm working on
  34.     a menu based version which integrates all the utilities in one unit
  35.     and with mouse control, etc. I'm releasing them so I can get your 
  36.     feedback on their performance or, well you know, bugs. I would like
  37.     them to be as clean as possible, so if you find any bugs tell me 
  38.     where you saw them or where you guess they are and I'll find'em 
  39.     and kill'em myself. Yeah!
  40.     
  41.     Limitations: Some of the utilities have limitations. With that I 
  42.     mean, that I'm still working on error handling on the command-line.
  43.     Here are a few things you should be aware of until they are fixed, 
  44.     or maybe you could help me solve:
  45.  
  46.     - The utilities accept numbers/characters for filenames. Re-check 
  47.       your command-line entries before execution.
  48.     - Keep the entries in the order they appear on the examples, since
  49.       I'm not using any letter/character to indicate the field entries.
  50.     - For now all the object generated will appear at 0,0,0.
  51.     - The utilities do not check for the existing filenames. They are
  52.       automatically overwritten. This may be handy sometimes. I am 
  53.       working on it.
  54.     - Some utilities close their objects with polygons. The polygons
  55.       are all marked by "// Cap #..." to make search and removal easy
  56.       in case they are not desired.
  57.  
  58. USAGE ----------------------------------------------------------------------
  59.  
  60.       ARCTORUS <outfile> (radius) (rad1) (rad2) (ang1) (ang2)
  61. Where:
  62.       outfile = name of file to receive the generated data.
  63.        radius = major radius of the arc/torus.
  64.          rad1 = initial radius of the minor radius.
  65.          rad2 = ending radius of the minor radius.
  66.          ang1 = starting angle for minor radius.
  67.          ang2 = ending angle for minor radius.
  68.  
  69. Examples: ARCTORUS donut.vo 3 .25 .25 0 360
  70.           ARCTORUS hoop.vo 5 .1 .1 0 360
  71.           ARCTORUS horn.vo 1.13 .46 .14 0 90
  72.  
  73. Note: This utility creates the arc or torus at (0,0,0) with the
  74.       opening facing up in the positive z-direction. The starting
  75.       angle is always located at (0,radius,0).
  76.       
  77.     - Initial angle cannot be larger than ending angle. 
  78.       It bums out. I'm working on it.
  79.  
  80. ----------------------------------------------------------------------------
  81.  
  82.        POLYGON (faces) (radius) (depth) <outfile>
  83. Where: 
  84.         faces = Number of faces of the polygon
  85.        radius = From base center to base edge.
  86.         depth = Vertical length of polygon.
  87.       outfile = Name of file to contain the object. 
  88.  
  89. Example: bolt 6 3 4 3 hexgon.dat  creates a hexagon, of radius 3 
  90.          and 4 units deep(or long), with both ends capped.
  91.          
  92. ----------------------------------------------------------------------------      
  93.  
  94.       PYRAMID (faces) (radius) (depth) <outfile> [c 1 | 0 ]
  95. Where: 
  96.         faces = Number of lateral faces of the pyramid.
  97.        radius = From base center to base edge.
  98.         depth = Vertical length perpendicular from the base to 
  99.                the apex of the pyramid.
  100.       outfile = Name of file to receive the generated data.
  101.             c = 1 - Cover the base;  0 - Leave it open.(Default=0)
  102.  
  103. Example: PYRAMID 4 2 3 pyramid.dat c 1 creates a four faced pyramid,
  104.          of base radius 2, 3 units deep, and a cover.
  105.  
  106. ----------------------------------------------------------------------------
  107.  
  108.           QUAD <outfile> (depth) (increment) [A]
  109. Where:
  110.       outfile = name of file to receive the generated data.
  111.         depth = vertical length of parabola.
  112.     increment = number of cones the parabola is made of.
  113.             A = factor to control the diameter of parabola.
  114.                 (default = 1.0)\n");
  115.  
  116. Example: QUAD para.bol 5 120 .1
  117.  
  118.    The simple  F(x) = y = A(x)^2 + B(x) + C  quadratic form was used for 
  119.    this utility. Since the parabolas are always created with their vertex 
  120.    at the (0,0,0), B and C where set to zero. This will simplify the task
  121.    of translating the object from one place to another.
  122.  
  123. ----------------------------------------------------------------------------      
  124.  
  125.        SPHERES (radius1) (radius2) (#layers) (#spheres) <outfile>
  126. Where:
  127.       radius1 = radius of the imaginary sphere.
  128.       radius2 = radius of the spheres on each layer.
  129.       #layers = number of layers to build the imaginary sphere.
  130.       #sphere = number of spheres per layer.
  131.       outfile = name of file to receive to generated data.
  132.  
  133. Example: SPHERE 5 0.2 180 90 balls.vo, creates a sphere of radius 5,
  134.          and made out of 180 layers, each layer consisting of 90 balls
  135.          with a radius of 0.2
  136.  
  137. Note: Please choose <#layers> and <#sphere> carefully since they accept  
  138.       large numbers and because of this, you may generate very large
  139.       files. Reasonable values for these two parameters range from
  140.       30 - 180 for <#layers> and 50 to 90 for <#sphere>.
  141.  
  142.      -The center of the object is located at (0,0,0).
  143.  
  144. NOTE -----------------------------------------------------------------------
  145.     
  146.     ARCTORUS, PYRAMID, POLYGON, QUAD, SPHERES and **COLORMAP are not 
  147.     shareware, they are all freeware, meaning that you can copy and
  148.     distribute them in their original status on a non-profit basis, 
  149.     which means that I retain all the rights on the source codes and 
  150.     that you cannot sell them.
  151.  
  152.     Enjoy them!
  153.     
  154.     ** ColorMap will only be released on request.
  155.  
  156. LEGAL INFO. & DISCLAIMER ---------------------------------------------------                         
  157.   
  158.    - No portion of this package may be separated from the package and 
  159.      distributed separately without the written permission of the author. 
  160.    - This software may not be included in whole or in part in any 
  161.      software without the written permission of the Norman Martina.
  162.    - This software may not be included in any publication, such as, but
  163.      not limited to, magazines, books, newspapers, or newsletters, without
  164.      the written permission of the Norman Martina.
  165.  
  166.    DISCLAIMER
  167.    ----------
  168.  
  169.    This software is provided as is without any guarantees or warranty.
  170.    Although the author have attempted to find and correct any bugs in 
  171.    the package, he is not responsible for any damage or losses of any 
  172.    kind caused by the use or misuse of the utilities. Norman Martina is 
  173.    under no obligation to provide service, corrections, or upgrades 
  174.    to this package.
  175.  
  176.    Vivid is a registered trademark of Vivid Software.
  177.    The author of Vivid is Stephen B. Coy (The Master of Raytracers).
  178.  
  179. HOW TO CONTACT ME ----------------------------------------------------------   
  180.    
  181.    If you want to know of any other utilities that I may have left in my
  182.    toolbox, drop me a letter or an E-Mail. 
  183.    I don't have time these days to answer all the questions as they come
  184.    in, since I have a full time job which is "looking for a real job", but
  185.    I'll make time to answer them all for sure.
  186.  
  187.    My address is: 
  188.                  Norman Martina
  189.                  36 Relroy Court
  190.                  Scarborough, ON.
  191.                  M1W 2Y7
  192.  
  193.    E-Mail me at:  
  194.                  Digital Pixel BBS
  195.                  "Canada's best and original graphics oriented BBS"
  196.                  Tel: (416) 289-1487
  197.  
  198.                  #305
  199.                  Image Data Online
  200.                  "The CAD oriented BBS"
  201.                  Tel: (416) 778-5700
  202.   
  203.   
  204.   
  205.   
  206. LAST BUT NOT LEAST ---------------------------------------------------------  
  207.   
  208.   I like to thank my loving(dushi) wife for all her love and patience. I 
  209. wonder how it must be to be married to someone who spends most of the 
  210. nights down in the cold basement tracing those photons rays. I guess we 
  211. are real "traceaholics."
  212.  
  213.